<!DOCTYPE html>
<html lang="en">

<head>
	<meta charset="UTF-8">
	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
	<meta name="keywords" content="README" />
	<meta name="description" content="README" />
	<!-- 网页标签标题 -->
	<title>README</title>
	<link rel="shortcut icon" href="/img/docsite.ico"/>
	<link rel="stylesheet" href="/build/documentation.css" />
</head>
<body>
	<div id="root"><div class="documentation-page" data-reactroot=""><header class="header-container header-container-normal"><div class="header-body"><a href="/zh-cn/index.html"><img class="logo" src="/pic/icon_name_black.png"/></a><div class="search search-normal"><span class="icon-search"></span></div><span class="language-switch language-switch-normal">En</span><div class="header-menu"><img class="header-menu-toggle" src="/img/system/menu_gray.png"/><ul><li class="menu-item menu-item-normal"><a href="/zh-cn/index.html" target="_self">首页</a></li><li class="menu-item menu-item-normal menu-item-normal-active"><a href="/zh-cn/docs/README.html" target="_self">文档</a></li></ul></div></div></header><div class="bar"><div class="bar-body"><img src="/img/system/docs.png" class="front-img"/><span>文档</span><img src="/img/system/docs.png" class="back-img"/></div></div><section class="content-section"><div class="sidemenu"><div class="sidemenu-toggle"><img src="https://img.alicdn.com/tfs/TB1E6apXHGYBuNjy0FoXXciBFXa-200-200.png"/></div><ul><li class="menu-item menu-item-level-1"><span>使用文档</span><ul><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><a href="/zh-cn/docs/README.html" target="_self">介绍</a></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><a href="/zh-cn/docs/FASTSTART.html" target="_self">快速开始</a></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><a href="/zh-cn/docs/update.html" target="_self">版本升级</a></li><li style="height:36px;overflow:hidden" class="menu-item menu-item-level-2"><a href="/zh-cn/docs/HELP.html" target="_self">后台使用指南</a></li></ul></li></ul></div><div class="doc-content markdown-body"><p align="center" >
    <img src="https://gitee.com/plumeorg/plumelog/raw/master/pic/icon.png" width="150">
    <h3 align="center">Plumelog</h3>
    <p align="center">
        Plumelog一个简单易用的java分布式日志组件
</p>
<p><a href="https://gitee.com/frankchenlong/plumelog/stargazers"><img src="https://gitee.com/plumeorg/plumelog/badge/star.svg?theme=gvp" alt="star"></a>
<a href="https://gitee.com/frankchenlong/plumelog/members"><img src="https://gitee.com/plumeorg/plumelog/badge/fork.svg?theme=gvp" alt="fork"></a>
<a href="https://www.apache.org/licenses/LICENSE-2.0.html"><img src="https://img.shields.io/badge/license-Apache%202-4EB1BA.svg" alt="License"></a>
<img src="https://img.shields.io/badge/JAVA-1.8+-green.svg" alt="java version">
<a href="https://maven-badges.herokuapp.com/maven-central/com.plumelog/plumelog"><img src="https://maven-badges.herokuapp.com/maven-central/com.plumelog/plumelog/badge.svg" alt="Maven Status"></a></p>
<p>Star趋势图
<a href="https://whnb.wang/plumeorg/plumelog"><img src="https://whnb.wang/img/plumeorg/plumelog" alt="Stargazers over time"></a></p>
<h3 id="%E4%B8%80.%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D">一.系统介绍 <a class="header-anchor" href="#%E4%B8%80.%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D">#</a></h3>
<ol>
<li>
<p>无代码入侵的分布式日志系统，基于log4j、log4j2、logback搜集日志，设置链路ID，方便查询关联日志</p>
</li>
<li>
<p>基于elasticsearch作为查询引擎</p>
</li>
<li>
<p>高吞吐，查询效率高</p>
</li>
<li>
<p>全程不占应用程序本地磁盘空间，免维护;对于项目透明，不影响项目本身运行</p>
</li>
<li>
<p>无需修改老项目，引入直接使用，支持dubbo,支持springcloud</p>
</li>
</ol>
<h3 id="%E4%BA%8C.%E6%9E%B6%E6%9E%84">二.架构 <a class="header-anchor" href="#%E4%BA%8C.%E6%9E%B6%E6%9E%84">#</a></h3>
<p><img src="/pic/plumelog.png" alt="avatar"></p>
<ul>
<li>
<p>plumelog-core 核心组件包含日志搜集端，负责搜集日志并推送到kafka，redis等队列</p>
</li>
<li>
<p>plumelog-server 负责把队列中的日志日志异步写入到elasticsearch</p>
</li>
<li>
<p>plumelog-demo 基于springboot的使用案例</p>
</li>
<li>
<p>plumelog-lite plumelog的嵌入式集成版本，免部署</p>
</li>
</ul>
<h3 id="%E4%B8%89.%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95">三.使用方法 <a class="header-anchor" href="#%E4%B8%89.%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95">#</a></h3>
<h4 id="%E4%BD%BF%E7%94%A8%E5%89%8D%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9">使用前注意事项 <a class="header-anchor" href="#%E4%BD%BF%E7%94%A8%E5%89%8D%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9">#</a></h4>
<ul>
<li>
<p>plumelog分三种启动模式，分别为redis,kafka,lite，外加嵌入式版本plumelog-lite</p>
</li>
<li>
<p>lite模式，不依赖任何外部中间件直接启动使用，但是性能有限，一天10个G以内可以应付，还必须是SSD硬盘，适合管理系统类的小玩家</p>
</li>
<li>
<p>redis,kafka模式可以集群分布式部署，适合大型玩家，互联网公司</p>
</li>
<li>
<p>plumelog-lite plumelog的嵌入式集成版本，直接pom引用，嵌入在项目中，自带查询界面，适合单个独立小项目使用，外包软件的最佳伴侣</p>
</li>
</ul>
<h4 id="1.-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3">1. <a href="/FASTSTART.md">使用文档</a> <a class="header-anchor" href="#1.-%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3">#</a></h4>
<h4 id="2.-%E6%9F%A5%E8%AF%A2%E5%90%8E%E5%8F%B0%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97">2. <a href="/HELP.md">查询后台使用指南</a> <a class="header-anchor" href="#2.-%E6%9F%A5%E8%AF%A2%E5%90%8E%E5%8F%B0%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97">#</a></h4>
<h4 id="3.-%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9">3. <a href="/update.md">版本升级注意事项</a> <a class="header-anchor" href="#3.-%E7%89%88%E6%9C%AC%E5%8D%87%E7%BA%A7%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9">#</a></h4>
<h4 id="4.-lite%E7%89%88%E6%9C%AC%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3">4. <a href="/plumelog-lite/README.md">lite版本使用文档</a> <a class="header-anchor" href="#4.-lite%E7%89%88%E6%9C%AC%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3">#</a></h4>
<h3 id="%E5%9B%9B.%E9%87%8D%E8%A6%81%E7%89%88%E6%9C%AC">四.重要版本 <a class="header-anchor" href="#%E5%9B%9B.%E9%87%8D%E8%A6%81%E7%89%88%E6%9C%AC">#</a></h3>
<table>
<thead>
<tr>
<th>版本</th>
<th>内容</th>
</tr>
</thead>
<tbody>
<tr>
<td>2.2.2</td>
<td>基于traceId的日志记录，日志查询，日志缓冲队列 redis或者kafka</td>
</tr>
<tr>
<td>3.0</td>
<td>增加错误报警模块，增加内容组合查询功能，日志分应用统计条数功能</td>
</tr>
<tr>
<td>3.1</td>
<td>增加扩展字段功能（MDC），优化日志搜集性能，合并UI和server模块，减少部署成本</td>
</tr>
<tr>
<td>3.2</td>
<td>重大升级优化，老用户赶紧升级 plumelog-server 到3.2</td>
</tr>
<tr>
<td>3.3</td>
<td>用做redis队列的时候，不同的服务可以使用不同的队列，极大增大了redis模式下的吞吐</td>
</tr>
<tr>
<td>3.4.1</td>
<td>可以配置日志压缩，redis使用LZ4压缩日志，redis使用LZ4压缩类型，支持redis集群模式和哨兵模式</td>
</tr>
<tr>
<td>3.5</td>
<td>增加了lite模式，lite模块，小玩家可以不用装redis和es啦！</td>
</tr>
</tbody>
</table>
<ul>
<li>发现严重bug问题版本，大家请跳过</li>
</ul>
<table>
<thead>
<tr>
<th>版本</th>
<th>bug问题</th>
</tr>
</thead>
<tbody>
<tr>
<td>3.2</td>
<td>阿里巴巴springcloud会出现日志不能上传bug，升级到3.2.1</td>
</tr>
<tr>
<td>3.4</td>
<td>升级到3.4.1即可</td>
</tr>
</tbody>
</table>
<h3 id="%E4%BA%94.%E8%81%94%E7%B3%BB%E4%BA%A4%E6%B5%81">五.联系交流 <a class="header-anchor" href="#%E4%BA%94.%E8%81%94%E7%B3%BB%E4%BA%A4%E6%B5%81">#</a></h3>
<ul>
<li>
<p>QQ群：二群：609090331</p>
</li>
<li>
<p>遇到问题可以先提issue，实在处理不了的加群讨论；提问带上你的配置截图和运行截图</p>
</li>
</ul>
<h3 id="%E5%85%AD.%E6%B5%8B%E8%AF%95%E5%9C%B0%E5%9D%80">六.测试地址 <a class="header-anchor" href="#%E5%85%AD.%E6%B5%8B%E8%AF%95%E5%9C%B0%E5%9D%80">#</a></h3>
<ul>
<li>
<p>查询界面地址：<a href="http://demo.plumelog.com">http://demo.plumelog.com</a>  用户名：admin 密码：admin   （测试服务器配置比较低大家简单体验即可）</p>
</li>
<li>
<p>访问这个地址产生测试log数据：<a href="http://log.plumelog.com/index?data=1234">http://log.plumelog.com/index?data=1234</a>  data参数自己随便传，传什么打印什么</p>
</li>
</ul>
<h3 id="%E4%B8%83.%E7%95%8C%E9%9D%A2%E6%88%AA%E5%9B%BE">七.界面截图 <a class="header-anchor" href="#%E4%B8%83.%E7%95%8C%E9%9D%A2%E6%88%AA%E5%9B%BE">#</a></h3>
<p><img src="/pic/0.png" alt="avatar"></p>
<p><img src="/pic/1.png" alt="avatar"></p>
<p><img src="/pic/2.png" alt="avatar"></p>
<p><img src="/pic/3.png" alt="avatar"></p>
<p><img src="/pic/4.png" alt="avatar"></p>
<p><img src="/pic/5.png" alt="avatar"></p>
<p><img src="/pic/6.png" alt="avatar"></p>
</div></section><footer class="footer-container"><div class="footer-body"><img src="/pic/icon_name_black.png"/><div class="cols-container"><div class="col col-12"><h3>免责声明</h3><p>本软件为免费软件并开放源码，用于交流学习，使用中遇到任何问题和纠纷本社区概不负责</p></div><div class="col col-6"><dl><dt>文档</dt><dd><a href="/zh-cn/docs/FASTSTART.html" target="_self">概览</a></dd><dd><a href="/zh-cn/docs/FASTSTART.html" target="_self">快速开始</a></dd><dd><a href="/zh-cn/docs/FASTSTARThtml" target="_self">开发者指南</a></dd></dl></div><div class="col col-6"><dl><dt>资源</dt><dd><a href="http://demo.plumelog.com" target="_self">演示地址</a></dd><dd><a href="https://gitee.com/plumeorg" target="_self">社区</a></dd></dl></div></div><div class="copyright"><span>Copyright © 2018 版权所有 plume开源社区</span></div></div></footer></div></div>
	<script src="https://f.alicdn.com/react/15.4.1/react-with-addons.min.js"></script>
	<script src="https://f.alicdn.com/react/15.4.1/react-dom.min.js"></script>
	<script>
		window.rootPath = '';
  </script>
	<script src="/build/documentation.js"></script>
</body>
</html>